<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>spade.xmppd.modules.muc.MUC</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="spade-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            ><a class="navbar" target="_top" href="http://spade2.googlecode.com">SPADE</a></th>
          </tr></table></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        <a href="spade-module.html">Package&nbsp;spade</a> ::
        <a href="spade.xmppd-module.html">Package&nbsp;xmppd</a> ::
        <a href="spade.xmppd.modules-module.html">Package&nbsp;modules</a> ::
        <a href="spade.xmppd.modules.muc-module.html">Module&nbsp;muc</a> ::
        Class&nbsp;MUC
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="spade.xmppd.modules.muc.MUC-class.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class MUC</h1><p class="nomargin-top"><span class="codelink"><a href="spade.xmppd.modules.muc-pysrc.html#MUC">source&nbsp;code</a></span></p>
<center>
<center>  <map id="uml_class_diagram_for_spade_xm_67" name="uml_class_diagram_for_spade_xm_67">
<area shape="rect" id="node2709" href="spade.xmppd.modules.muc.MUC-class.html#NS" title="spade.xmppd.modules.muc.MUC.NS" alt="" coords="17,164,313,183"/>
<area shape="rect" id="node2709" href="spade.xmppd.modules.muc.MUC-class.html#plugin" title="spade.xmppd.modules.muc.MUC.plugin" alt="" coords="17,185,313,204"/>
<area shape="rect" id="node2709" href="spade.xmppd.modules.muc.MUC-class.html#printMUC" title="Show a textual representation of the conference" alt="" coords="17,204,313,223"/>
<area shape="rect" id="node2709" href="spade.xmppd.modules.muc.MUC-class.html#addRoom" title="Add a room to the conference" alt="" coords="17,223,313,241"/>
<area shape="rect" id="node2709" href="spade.xmppd.modules.muc.MUC-class.html#destroyRoom" title="Destroy a room (for a reason)." alt="" coords="17,241,313,260"/>
<area shape="rect" id="node2709" href="spade.xmppd.modules.muc.MUC-class.html#dispatch" title="Mini&#45;dispatcher for the jabber stanzas that arrive to the Conference" alt="" coords="17,260,313,279"/>
<area shape="rect" id="node2709" href="spade.xmppd.modules.muc.MUC-class.html#Presence_cb" title="Callback for presence stanzas directed to the conference itself" alt="" coords="17,279,313,297"/>
<area shape="rect" id="node2709" href="spade.xmppd.modules.muc.MUC-class.html#notExist_cb" title="Callback called when a stanza is directed to a room that does not (yet) &#160;exist" alt="" coords="17,297,313,316"/>
<area shape="rect" id="node2709" href="spade.xmppd.modules.muc.MUC-class.html#IQ_cb" title="Manages IQ stanzas directed to the Conference itself" alt="" coords="17,316,313,335"/>
<area shape="rect" id="node2709" href="spade.xmppd.modules.muc.MUC-class.html#loadRoomDB" title="Load persistent rooms and their configurations to the database" alt="" coords="17,335,313,353"/>
<area shape="rect" id="node2709" href="spade.xmppd.modules.muc.MUC-class.html#saveRoomDB" title="Save persistent rooms and their configurations to a static database" alt="" coords="17,353,313,372"/>
<area shape="rect" id="node1" href="spade.xmppd.modules.muc.MUC-class.html" title="The conference component." alt="" coords="5,139,325,378"/>
<area shape="rect" id="node2710" href="javascript:void(0);" title="Feed a provided debug line to main instance&#39;s debug facility along with our ID string." alt="" coords="63,39,267,57"/>
<area shape="rect" id="node2710" href="javascript:void(0);" title="Attach to main instance and register ourself and all our staff in it." alt="" coords="63,57,267,76"/>
<area shape="rect" id="node2710" href="javascript:void(0);" title="Unregister all our staff from main instance and detach from it." alt="" coords="63,76,267,95"/>
<area shape="rect" id="node2710" href="javascript:void(0);" title="xmpp.client.PlugIn.__init__" alt="" coords="63,95,267,113"/>
<area shape="rect" id="node2" href="javascript:void(0);" title="Common xmpppy plugins infrastructure: plugging in/out, debugging." alt="" coords="51,6,277,119"/>
</map>
  <img src="uml_class_diagram_for_spade_xm_67.gif" alt='' usemap="#uml_class_diagram_for_spade_xm_67" ismap="ismap" class="graph-without-title" />
</center>
</center>
<hr />
<p>The conference component. Composed of multiple rooms</p>

<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Instance Methods</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-InstanceMethods"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="plugin"></a><span class="summary-sig-name">plugin</span>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">server</span>)</span></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="spade.xmppd.modules.muc-pysrc.html#MUC.plugin">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="printMUC"></a><span class="summary-sig-name">printMUC</span>(<span class="summary-sig-arg">self</span>)</span><br />
      Show a textual representation of the conference</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="spade.xmppd.modules.muc-pysrc.html#MUC.printMUC">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="addRoom"></a><span class="summary-sig-name">addRoom</span>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">room</span>=<span class="summary-sig-default">None</span>,
        <span class="summary-sig-arg">name</span>=<span class="summary-sig-default">None</span>)</span><br />
      Add a room to the conference</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="spade.xmppd.modules.muc-pysrc.html#MUC.addRoom">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="spade.xmppd.modules.muc.MUC-class.html#destroyRoom" class="summary-sig-name">destroyRoom</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">name</span>,
        <span class="summary-sig-arg">owner_session</span>,
        <span class="summary-sig-arg">stanza</span>)</span><br />
      Destroy a room (for a reason).</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="spade.xmppd.modules.muc-pysrc.html#MUC.destroyRoom">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="dispatch"></a><span class="summary-sig-name">dispatch</span>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">session</span>,
        <span class="summary-sig-arg">stanza</span>)</span><br />
      Mini-dispatcher for the jabber stanzas that arrive to the Conference</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="spade.xmppd.modules.muc-pysrc.html#MUC.dispatch">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="Presence_cb"></a><span class="summary-sig-name">Presence_cb</span>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">session</span>,
        <span class="summary-sig-arg">stanza</span>)</span><br />
      Callback for presence stanzas directed to the conference itself</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="spade.xmppd.modules.muc-pysrc.html#MUC.Presence_cb">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="notExist_cb"></a><span class="summary-sig-name">notExist_cb</span>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">session</span>,
        <span class="summary-sig-arg">stanza</span>)</span><br />
      Callback called when a stanza is directed to a room that does not 
      (yet) exist</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="spade.xmppd.modules.muc-pysrc.html#MUC.notExist_cb">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="IQ_cb"></a><span class="summary-sig-name">IQ_cb</span>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">session</span>,
        <span class="summary-sig-arg">iq</span>)</span><br />
      Manages IQ stanzas directed to the Conference itself</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="spade.xmppd.modules.muc-pysrc.html#MUC.IQ_cb">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="loadRoomDB"></a><span class="summary-sig-name">loadRoomDB</span>(<span class="summary-sig-arg">self</span>)</span><br />
      Load persistent rooms and their configurations to the database</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="spade.xmppd.modules.muc-pysrc.html#MUC.loadRoomDB">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="saveRoomDB"></a><span class="summary-sig-name">saveRoomDB</span>(<span class="summary-sig-arg">self</span>)</span><br />
      Save persistent rooms and their configurations to a static database</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="spade.xmppd.modules.muc-pysrc.html#MUC.saveRoomDB">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code>xmpp.client.PlugIn</code></b>:
      <code>DEBUG</code>,
      <code>PlugIn</code>,
      <code>PlugOut</code>,
      <code>__init__</code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== CLASS VARIABLES ==================== -->
<a name="section-ClassVariables"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Class Variables</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-ClassVariables"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a name="NS"></a><span class="summary-name">NS</span> = <code title="''"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></code>
    </td>
  </tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Method Details</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-MethodDetails"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
</table>
<a name="destroyRoom"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">destroyRoom</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">name</span>,
        <span class="sig-arg">owner_session</span>,
        <span class="sig-arg">stanza</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="spade.xmppd.modules.muc-pysrc.html#MUC.destroyRoom">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Destroy a room (for a reason). A venue (alternative new room) may be 
  declared to take place of the destroyed room</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="spade-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            ><a class="navbar" target="_top" href="http://spade2.googlecode.com">SPADE</a></th>
          </tr></table></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1 on Wed Aug  1 18:44:59 2012
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
